home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / gcc / ixemsdk.lha / man / cat3 / setbuf.0 < prev    next >
Text File  |  1996-09-02  |  4KB  |  93 lines
  1.  
  2. SETBUF(3)                  UNIX Programmer's Manual                  SETBUF(3)
  3.  
  4. NNAAMMEE
  5.      sseettbbuuff, sseettbbuuffffeerr, sseettlliinneebbuuff, sseettvvbbuuff - stream buffering operations
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ##iinncclluuddee <<ssttddiioo..hh>>
  9.  
  10.      _v_o_i_d
  11.      sseettbbuuff(_F_I_L_E _*_s_t_r_e_a_m, _c_h_a_r _*_b_u_f)
  12.  
  13.      _v_o_i_d
  14.      sseettbbuuffffeerr(_F_I_L_E _*_s_t_r_e_a_m, _c_h_a_r _*_b_u_f, _s_i_z_e___t _s_i_z_e)
  15.  
  16.      _i_n_t
  17.      sseettlliinneebbuuff(_F_I_L_E _*_s_t_r_e_a_m)
  18.  
  19.      _i_n_t
  20.      sseettvvbbuuff(_F_I_L_E _*_s_t_r_e_a_m, _c_h_a_r _*_b_u_f, _i_n_t _m_o_d_e, _s_i_z_e___t _s_i_z_e)
  21.  
  22. DDEESSCCRRIIPPTTIIOONN
  23.      The three types of buffering available are unbuffered, block buffered,
  24.      and line buffered.  When an output stream is unbuffered, information ap-
  25.      pears on the destination file or terminal as soon as written; when it is
  26.      block buffered many characters are saved up and written as a block; when
  27.      it is line buffered characters are saved up until a newline is output or
  28.      input is read from any stream attached to a terminal device (typically
  29.      stdin).  The function fflush(3) may be used to force the block out early.
  30.      (See fclose(3).)
  31.  
  32.      Normally all files are block buffered.  When the first I/O operation oc-
  33.      curs on a file, malloc(3) is called, and an optimally-sized buffer is ob-
  34.      tained.  If a stream refers to a terminal (as _s_t_d_o_u_t normally does) it is
  35.      line buffered.  The standard error stream _s_t_d_e_r_r is always unbuffered.
  36.  
  37.      The sseettvvbbuuff() function may be used to alter the buffering behavior of a
  38.      stream.  The _m_o_d_e parameter must be one of the following three macros:
  39.  
  40.            _IONBF  unbuffered
  41.  
  42.            _IOLBF  line buffered
  43.  
  44.            _IOFBF  fully buffered
  45.  
  46.      The _s_i_z_e parameter may be given as zero to obtain deferred optimal-size
  47.      buffer allocation as usual.  If it is not zero, then except for un-
  48.      buffered files, the _b_u_f argument should point to a buffer at least _s_i_z_e
  49.      bytes long; this buffer will be used instead of the current buffer.  (If
  50.      the _s_i_z_e argument is not zero but _b_u_f is NULL, a buffer of the given size
  51.      will be allocated immediately, and released on close.  This is an exten-
  52.      sion to ANSI C; portable code should use a size of 0 with any NULL
  53.      buffer.)
  54.  
  55.      The sseettvvbbuuff() function may be used at any time, but may have peculiar
  56.      side effects (such as discarding input or flushing output) if the stream
  57.      is ``active''.  Portable applications should call it only once on any
  58.      given stream, and before any I/O is performed.
  59.  
  60.      The other three calls are, in effect, simply aliases for calls to
  61.      sseettvvbbuuff().  Except for the lack of a return value, the sseettbbuuff() function
  62.      is exactly equivalent to the call
  63.  
  64.            setvbuf(stream, buf, buf ? _IOFBF : _IONBF, BUFSIZ);
  65.  
  66.  
  67.      The sseettbbuuffffeerr() function is the same, except that the size of the buffer
  68.      is up to the caller, rather than being determined by the default BUFSIZ.
  69.      The sseettlliinneebbuuff() function is exactly equivalent to the call:
  70.  
  71.            setvbuf(stream, (char *)NULL, _IOLBF, 0);
  72.  
  73. RREETTUURRNN VVAALLUUEESS
  74.      The sseettvvbbuuff() function returns 0 on success, or EOF if the request cannot
  75.      be honored (note that the stream is still functional in this case).
  76.  
  77.      The sseettlliinneebbuuff() function returns what the equivalent sseettvvbbuuff() would
  78.      have returned.
  79.  
  80. SSEEEE AALLSSOO
  81.      fopen(3),  fclose(3),  fread(3),  malloc(3),  puts(3),  printf(3)
  82.  
  83. SSTTAANNDDAARRDDSS
  84.      The sseettbbuuff() and sseettvvbbuuff() functions conform to ANSI C3.159-1989 (``ANSI
  85.      C'').
  86.  
  87. BBUUGGSS
  88.      The sseettbbuuffffeerr() and sseettlliinneebbuuff() functions are not portable to versions
  89.      of BSD UNIX before 4.2BSD. On 4.2BSD and 4.3BSD systems, sseettbbuuff() always
  90.      uses a suboptimal buffer size and should be avoided.
  91.  
  92. 4th Berkeley Distribution        June 4, 1993                                2
  93.